Vcenter Vm DataSets CreateSpec

The Vcenter Vm DataSets CreateSpec schema describes a data set to be created.

This schema was added in vSphere API 8.0.0.0.

JSON Example

{
    "name": "string",
    "description": "string",
    "host": "string",
    "guest": "string",
    "omit_from_snapshot_and_clone": false
}

string

name

Required

The name of the data set. __ It is recommended that this value take the form "com.company.project" to avoid conflict with other uses.__

This property was added in vSphere API 8.0.0.0.

string

description

Required

A description of how the data set is used by its creator. This field can contain up to 1024 bytes.

This property was added in vSphere API 8.0.0.0.

string

host

Required

Host access control.

Controls access to the data set by the Vcenter Vm DataSets Entries operations.

For more information see: Vcenter Vm DataSets Access.

This property was added in vSphere API 8.0.0.0.

string

guest

Required

Guest access control.

Controls access to the data set from the in-guest APIs.

For more information see: Vcenter Vm DataSets Access.

This property was added in vSphere API 8.0.0.0.

boolean

omit_from_snapshot_and_clone

Optional

If set, the data set is considered a property of the virtual machine, and is not included in a snapshot operation or when the virtual machine is cloned. When a virtual machine is reverted to a snapshot, any data set with {@link #omitFromSnapshotAndClone) {@term set} will be destroyed. Any data set with {@link #omitFromSnapshotAndClone} {@term unset} will be restored to the state when the snapshot was created.

This property was added in vSphere API 8.0.0.0.

If missing or null, the data set is copied when a virtual machine is cloned or a snapshot is taken.

Parameter To

Vcenter Vm DataSets create